/* Copyright (c) 2025 Beijing Semidrive Technology Corporation
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/** *****************************************************************************************************
 *  \file     Mcu_KickCore.h                                                                            *
 *  \brief    This file contains interface header for Mcu MCAL driver, ...                              *
 *                                                                                                      *
 * <table>                                                                                              *
 * <tr><th>Date           <th>Version                                                                   *
 * <tr><td>2023/08/02     <td>1.0.0                                                                     *
 * </table>                                                                                             *
 *******************************************************************************************************/

#ifndef MCU_KICKCORE_H
#define MCU_KICKCORE_H

/********************************************************************************************************
 *                                      Include header files                                            *
 *******************************************************************************************************/
#include "Platform_Types.h"
#include "Std_Types.h"

/********************************************************************************************************
 *                                  Global Types definition                                             *
 *******************************************************************************************************/
/* NOTE: This enum shall be only used for core kicking scenario */
typedef enum
{
    /* 0-3 for CR52, 4 for se, 5 for lp */
    KICK_CPU_INDEX_0 = 0U,
    KICK_CPU_INDEX_1,
    KICK_CPU_INDEX_2,
    KICK_CPU_INDEX_3,
    KICK_CPU_INDEX_4,
    KICK_CPU_INDEX_5,
    KICK_CPU_INDEX_MAX
} Mcu_KickCoreType;

/********************************************************************************************************
 *                                  Global Function Declarations                                        *
 *******************************************************************************************************/
/** *****************************************************************************************************
 * \brief This function kickcore.
 *
 * \verbatim
 * Syntax             : Std_ReturnType Mcu_Ip_SocKickCore(Mcu_KickCoreType core, uint32 entry)
 *
 * Service ID[hex]    : None
 *
 * Sync/Async         : Synchronous
 *
 * Reentrancy         : Non reentrant
 *
 * Parameters (in)    : core - core to reset
 *                      entry - vector table address for CR52 core and remap address for lp core
 *
 * Parameters (inout) : None
 *
 * Parameters (out)   : None
 *
 * Return value       : errID
 *
 * Description        : This function kickcore.
 * \endverbatim
 *******************************************************************************************************/
Std_ReturnType Mcu_Ip_SocKickCore(Mcu_KickCoreType core, uint32 entry);

#endif /* MCU_KICKCORE_H */
/* End of file */
